/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.flink.table.api;

import org.apache.flink.table.descriptors.DescriptorProperties;
import org.apache.flink.table.factories.TableFactory;

import javax.annotation.Nullable;

import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;

/**
 * Exception for not finding a {@link TableFactory} for the given properties.
 */
public class NoMatchingTableFactoryException extends RuntimeException {

	// message that indicates the current matching step
	private final String message;
	// message that indicates the best matched factory
	@Nullable
	private final String matchCandidatesMessage;
	// required factory class
	private final Class<?> factoryClass;
	// all found factories
	private final List<TableFactory> factories;
	// properties that describe the configuration
	private final Map<String, String> properties;

	public NoMatchingTableFactoryException(
		String message,
		@Nullable String matchCandidatesMessage,
		Class<?> factoryClass,
		List<TableFactory> factories,
		Map<String, String> properties,
		Throwable cause) {

		super(cause);
		this.message = message;
		this.matchCandidatesMessage = matchCandidatesMessage;
		this.factoryClass = factoryClass;
		this.factories = factories;
		this.properties = properties;
	}

	public NoMatchingTableFactoryException(
		String message,
		Class<?> factoryClass,
		List<TableFactory> factories,
		Map<String, String> properties) {
		this(message, null, factoryClass, factories, properties, null);
	}

	public NoMatchingTableFactoryException(
		String message,
		@Nullable String matchCandidatesMessage,
		Class<?> factoryClass,
		List<TableFactory> factories,
		Map<String, String> properties) {
		this(message, matchCandidatesMessage, factoryClass, factories, properties, null);
	}

	@Override
	public String getMessage() {
		String matchCandidatesString = matchCandidatesMessage == null ?
			"" :
			"The matching candidates:\n" + matchCandidatesMessage + "\n\n";
		return String.format(
			"Could not find a suitable table factory for '%s' in\nthe classpath.\n\n" +
				"Reason: %s\n\n%s" +
				"The following properties are requested:\n%s\n\n" +
				"The following factories have been considered:\n%s",
			factoryClass.getName(),
			message,
			matchCandidatesString,
			DescriptorProperties.toString(properties),
			factories.stream().map(p -> p.getClass().getName()).collect(Collectors.joining("\n"))
		);
	}
}
